io.appManager.myInstance.applicationApplicationinterface
Object describing an app.
Properties (7)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| caption⚓︎ | string | x | x | Application caption. |
| icon⚓︎ | string | x | x | Application icon. |
| instances⚓︎ | Instance[] | x | Instances of that app. |
|
| name⚓︎ | string | x | Application name. |
|
| title⚓︎ | string | x | x | Application title. |
| userProperties⚓︎ | PropertiesObject | x | Generic object for passing properties, settings, etc., in the for of key/value pairs. |
|
| version⚓︎ | string | x | x | Application version. |
4 Methods
getConfiguration()⚓︎
() => Promise<Definition>
Retrieves the definition of the current app.
io.Connect Browser 4.3onInstanceStarted()⚓︎
(callback: (instance: Instance) => any) => UnsubscribeFunction
Subscribes for the event which fires when an application instance is started.
Note: unlike the API's onInstanceStarted() the Application's onInstanceStarted() method doesn't replay the already started instances.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | (instance: Instance) => any | Callback function to handle the newly started instance. |
Returns
Unsubscribe function.
onInstanceStopped()⚓︎
(callback: (instance: Instance) => any) => UnsubscribeFunction
start()⚓︎
(context?: object, options?: ApplicationStartOptions) => Promise<Instance>
Returns the newly started application instance.
Parameters (2)
| Name | Type | Required | Description |
|---|---|---|---|
| context⚓︎ | object | x | The initial context of the application. |
| options⚓︎ | ApplicationStartOptions | x | Options object in which you can specify window setting (that will override the default configuration settings), as well as other additional options. |
Returns
Promise that resolves with the newly started application instance.